Skip to main content

GetBucketWebsite

Description

GetBucketWebsite operation is used to view the static website hosting status of Bucket.

Request Method

POST

Request Path

/apsara/route/OneRouter/GetBucketWebsite

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
IndexDocumentBODYcontainerNoNo sample value for this parameter.parent element of child element Suffix.
SuffixBODYstringNoNo sample value for this parameter.the index file name added when returning the directory URL should not be empty or contain forward slashes (/). For example, if the index file is set to index.html, access.
regionIdBODYstringYesNo sample value for this parameter.region id
WebsiteConfigurationBODYcontainerNoNo sample value for this parameter.the requested container.
versionBODYstringNo2016-01-01version of api
KeyBODYstringNoNo sample value for this parameter.file name used when returning 404 error.
ErrorDocumentBODYcontainerNoNo sample value for this parameter.parent of child key.

Return data

NameTypeSample valueDescription
RequestIDstring1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DCRequest id

Example

Successful Response example

{
"RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}